home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / perldoc.z / perldoc
Encoding:
Text File  |  2002-10-03  |  5.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. PPPPEEEERRRRLLLLDDDDOOOOCCCC((((1111))))                                                          PPPPEEEERRRRLLLLDDDDOOOOCCCC((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      perldoc - Look up Perl documentation in pod format.
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ppppeeeerrrrllllddddoooocccc [----hhhh] [----vvvv] [----tttt] [----uuuu] [----mmmm] [----llll] [----FFFF]  [----XXXX]
  13.      PageName|ModuleName|ProgramName
  14.  
  15.      ppppeeeerrrrllllddddoooocccc ----ffff BuiltinFunction
  16.  
  17.      ppppeeeerrrrllllddddoooocccc ----qqqq FAQ Keyword
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      _p_e_r_l_d_o_c looks up a piece of documentation in .pod format that is embedded
  21.      in the perl installation tree or in a perl script, and displays it via
  22.      pod2man | nroff -man | $PAGER. (In addition, if running under HP-UX, col
  23.      -x will be used.) This is primarily used for the documentation for the
  24.      perl library modules.
  25.  
  26.      Your system may also have man pages installed for those modules, in which
  27.      case you can probably just use the _m_a_n(1) command.
  28.  
  29. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  30.      ----hhhh help
  31.           Prints out a brief help message.
  32.  
  33.      ----vvvv verbose
  34.           Describes search for the item in detail.
  35.  
  36.      ----tttt text output
  37.           Display docs using plain text converter, instead of nroff. This may
  38.           be faster, but it won't look as nice.
  39.  
  40.      ----uuuu unformatted
  41.           Find docs only; skip reformatting by pod2*
  42.  
  43.      ----mmmm module
  44.           Display the entire module: both code and unformatted pod
  45.           documentation.  This may be useful if the docs don't explain a
  46.           function in the detail you need, and you'd like to inspect the code
  47.           directly; perldoc will find the file for you and simply hand it off
  48.           for display.
  49.  
  50.      ----llll file name only
  51.           Display the file name of the module found.
  52.  
  53.      ----FFFF file names
  54.           Consider arguments as file names, no search in directories will be
  55.           performed.
  56.  
  57.      ----ffff perlfunc
  58.           The ----ffff option followed by the name of a perl built in function will
  59.           extract the documentation of this function from the _p_e_r_l_f_u_n_c
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PPPPEEEERRRRLLLLDDDDOOOOCCCC((((1111))))                                                          PPPPEEEERRRRLLLLDDDDOOOOCCCC((((1111))))
  71.  
  72.  
  73.  
  74.           manpage.
  75.  
  76.      ----qqqq perlfaq
  77.           The ----qqqq option takes a regular expression as an argument.  It will
  78.           search the question headings in perlfaq[1-9] and print the entries
  79.           matching the regular expression.
  80.  
  81.      ----XXXX use an index if present
  82.           The ----XXXX option looks for a entry whose basename matches the name
  83.           given on the command line in the file $Config{archlib}/pod.idx.  The
  84.           pod.idx file should contain fully qualified filenames, one per line.
  85.  
  86.      PPPPaaaaggggeeeeNNNNaaaammmmeeee||||MMMMoooodddduuuulllleeeeNNNNaaaammmmeeee||||PPPPrrrrooooggggrrrraaaammmmNNNNaaaammmmeeee
  87.           The item you want to look up.  Nested modules (such as
  88.           File::Basename) are specified either as File::Basename or
  89.           File/Basename.  You may also give a descriptive name of a page, such
  90.           as perlfunc. You make also give a partial or wrong-case name, such
  91.           as "basename" for "File::Basename", but this will be slower, if
  92.           there is more then one page with the same partial name, you will
  93.           only get the first one.
  94.  
  95. EEEENNNNVVVVIIIIRRRROOOONNNNMMMMEEEENNNNTTTT
  96.      Any switches in the PERLDOC environment variable will be used before the
  97.      command line arguments.  perldoc also searches directories specified by
  98.      the PERL5LIB (or PERLLIB if PERL5LIB is not defined) and PATH environment
  99.      variables.  (The latter is so that embedded pods for executables, such as
  100.      perldoc itself, are available.)  perldoc will use, in order of
  101.      preference, the pager defined in PERLDOC_PAGER, MANPAGER, or PAGER before
  102.      trying to find a pager on its own.  (MANPAGER is not used if perldoc was
  103.      told to display plain text or unformatted pod.)
  104.  
  105. AAAAUUUUTTTTHHHHOOOORRRR
  106.      Kenneth Albanowski <kjahds@kjahds.com>
  107.  
  108.      Minor updates by Andy Dougherty <doughera@lafcol.lafayette.edu>
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. PPPPEEEERRRRLLLLDDDDOOOOCCCC((((1111))))                                                          PPPPEEEERRRRLLLLDDDDOOOOCCCC((((1111))))
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.                                                                         PPPPaaaaggggeeee 3333
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.